API Documentation
Buffer.h
1 // Buffer.h
3 //
5 
6 namespace nkMemory
7 {
12  {
13  unsigned char* _data ;
14  unsigned long long _size ;
15  } ;
16 }
17 
18 namespace nkMemory
19 {
31  class Buffer final
32  {
33  public :
34 
35  // Constructors, destructor
39  Buffer () ;
46  Buffer (unsigned long long size) ;
53  Buffer (unsigned char* data, unsigned long long size) ;
60  Buffer (const Buffer& other) ;
67  Buffer (Buffer&& other) ;
72  ~Buffer () ;
73 
74  // Getters
78  unsigned char* getData () const ;
82  unsigned long long getSize () const ;
86  bool empty () const ;
90  unsigned char& front () ;
94  const unsigned char& front () const ;
98  unsigned char& back () ;
102  const unsigned char& back () const ;
103 
104  // Management
108  void clear () ;
115  void resize (unsigned long long size) ;
123  unsigned char& append (unsigned char value) ;
131  unsigned char& append (unsigned char value) ;
139  BufferInfo relinquishDataOwnership () ;
140 
141  // Operators
148  unsigned char& operator[] (unsigned long long index) ;
155  const unsigned char& operator[] (unsigned long long index) const ;
156 
163  Buffer& operator= (const Buffer& other) ;
171 
172  public :
173 
174  // Constructors templated
180  template <typename T>
181  Buffer (const std::vector<T>& vec) ;
182 
183  public :
184 
185  // Memory ownership taking constructors
197  static Buffer createAndTakeMemory (unsigned char* data, unsigned long long size) ;
198  } ;
199 }
nkMemory::Buffer::getData
unsigned char * getData() const
nkMemory::Buffer::operator[]
unsigned char & operator[](unsigned long long index)
nkMemory::Buffer::resize
void resize(unsigned long long size)
nkMemory::Buffer::Buffer
Buffer(const std::vector< T > &vec)
nkMemory::Buffer::Buffer
Buffer(unsigned long long size)
nkMemory::Buffer::createAndTakeMemory
static Buffer createAndTakeMemory(unsigned char *data, unsigned long long size)
nkMemory::BufferDataDescriptor::_size
unsigned long long _size
The size, in bytes, of the data pointed.
Definition: Buffer.h:14
nkMemory::Buffer::front
const unsigned char & front() const
nkMemory::Buffer::Buffer
Buffer()
nkMemory::BufferDataDescriptor::_data
unsigned char * _data
The data pointer.
Definition: Buffer.h:13
nkMemory::Buffer::~Buffer
~Buffer()
nkMemory::Buffer::relinquishDataOwnership
BufferInfo relinquishDataOwnership()
nkMemory::Buffer
A buffer holding binary data.
Definition: Buffer.h:32
nkMemory::Buffer::Buffer
Buffer(Buffer &&other)
nkMemory::Buffer::back
unsigned char & back()
nkMemory::BufferDataDescriptor
Describes the data held by a buffer.
Definition: Buffer.h:12
nkMemory::Buffer::getSize
unsigned long long getSize() const
nkMemory::Buffer::Buffer
Buffer(const Buffer &other)
nkMemory::Buffer::clear
void clear()
nkMemory::Buffer::append
unsigned char & append(unsigned char value)
nkMemory::Buffer::front
unsigned char & front()
nkMemory::Buffer::empty
bool empty() const
nkMemory::Buffer::Buffer
Buffer(unsigned char *data, unsigned long long size)
nkMemory::Buffer::back
const unsigned char & back() const
nkMemory::Buffer::operator=
Buffer & operator=(const Buffer &other)
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7